home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / gfx / show / ppshow30a.lha / PPShow / PPShow.doc < prev    next >
Text File  |  1992-12-13  |  23KB  |  491 lines
  1.  
  2.  
  3.                             PPShow 3.0a User Manual
  4.  
  5.                                  Dec 12, 1992
  6.  
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12. The programs and files in this distribution are freely distributable, but are
  13. also copyright (c) Nico François.  They may be freely distributed as long as
  14. no more than a nominal fee is charged to cover time and copying costs.
  15.    No commercial usage is permitted without written permission from the
  16. author.  Everything in this distribution must be kept together, in original
  17. unmodified form.
  18.    The above is generally known as freeware.
  19.  
  20.    If you have suggestions or remarks about this program, or if you find
  21. any bugs, please let me know.
  22.  
  23.    Contacting the author:
  24.  
  25.      Fido:  2:292/603.10 (Nico Francois)
  26.  
  27.      UUCP:  Nico.Francois@p10.f603.n292.z2.FidoNet.Org
  28.  
  29.      Mail:  Nico François
  30.             Corbielaan 13
  31.             B-3060 Bertem
  32.             BELGIUM
  33.  
  34.    If you can please use e-mail.  That way you'll stand a much better chance
  35. of getting a reply quickly.
  36.  
  37.    PPShow 3.0a requires AmigaDOS Release 2 (Kickstart & Workbench 2.0) or
  38. higher to run.
  39.  
  40.  
  41. Contents
  42. ========
  43.  
  44. 1. An introduction
  45.  
  46. 2. Usage
  47.  
  48. 3. Features
  49.  
  50. 4. Note on crunching
  51.  
  52.  
  53. 1. An introduction
  54. ==================
  55.  
  56.    PPShow was written to complement one of my other utilities, PowerPacker
  57. (a command and data cruncher).  It is used to show normal IFF ILBM files or
  58. ILBM files crunched with PowerPacker.  The decrunching is done automatically
  59. so the user doesn't have to know if a file is crunched or not.  From version
  60. 3.0 PPShow will now also play standard Op5 animations.  The ANIM Op5 format
  61. is used by most ANIM generating programs, including DPaint IV.
  62.  
  63.    PPShow uses 'powerpacker.library' and 'reqtools.library', so make sure
  64. these are present in your Libs: directory.  Double-click 'Install_libs' for
  65. an automatic installation.
  66.  
  67.    If you haven't got PowerPacker you are of course missing one of the main
  68. features of this program.  PowerPacker is available as shareware (up to
  69. version 2.3b) or as a commercial program (version 4.0a).  Order a copy from
  70. UGA, P.O.Box 881, 3700 AW Zeist, The Netherlands or from JumpDisk, 1493 Mt.
  71. View Ave., Chico CA 95926, USA.  The commercial version offers several
  72. enhancements like 40 to 50 times faster crunching, overlay support, an ARexx
  73. port, and much more.
  74.  
  75.  
  76. 2. Usage
  77. ========
  78.  
  79.    PPShow can be used in several different ways.
  80.  
  81. - First of all via the CLI:
  82.  
  83.    If you enter 'PPShow ?' you will get a standard AmigaDOS usage template,
  84. enter 'PPShow ??' for more information.  You use PPShow like this:
  85.  
  86.    PPShow {<file>|<dir>|-c} [LO] [HI] [SHI] [PROD] [L=LACE] [NL=NOLACE]
  87.           [HAM] [TIME s] [NOCYCLE] [NO=NOOVERSCAN] [A2024 [15Hz]]
  88.           [PAL] [NTSC] [VGA] [LOOP] [NOFLICKER] [MO=MAXOSCAN]
  89.           [J=JIFFIES n] [T=TIMES n] [R=REPEAT] [NOANIM]
  90.  
  91.    The program will by default load the specified ILBM file or ANIM file and
  92. display/play it.  If the file was crunched using PowerPacker 2.0 or higher
  93. PPShow will first decrunch it for you.  If the file was encrypted you will be
  94. prompted for the password.  You may specify more than one file on the command
  95. line and you may even use wildcards, PPShow will show all files one at a time,
  96. double buffering the display.
  97.  
  98.    If you specify "-c" as a filename ('PPShow -c') PPShow will show you the
  99. contents of the clipboard (if it contains an ILBM).  ANIM files will not be
  100. played from the clipboard.
  101.  
  102.    When PPShow encounters a GIF file (common on MS-DOS systems) it will try to
  103. execute a GIF viewer to show this picture.  Default GIF viewer that is run is
  104. the very fast TurboGIF, but any viewer can be selected by setting the
  105. environment variable GIFVIEWER.  You can include options in this variable.
  106. For example: ' SetEnv GIFVIEWER "TurboGIF -k7" '.  Make sure the GIF viewer is
  107. in your path.
  108.  
  109.    If you enter PPShow without options, you will be presented with a
  110. file requester.  Entering PPShow with a directory instead of a file as an
  111. argument will also get you a requester, but it will be positioned in the
  112. directory you specified.
  113.  
  114.    There are several command line options:
  115.  
  116.      LORES      : Force screen to open in LORES        mode.
  117.      HIRES      :   ''    ''    ''   ''   HIRES         ''
  118.      SUPERHIRES :   ''    ''    ''   ''   SUPERHIRES    ''
  119.      PROD       :   ''    ''    ''   ''   PRODUCTIVITY  ''
  120.      LACE       : Force interlace on.
  121.      NOLACE     : Force interlace off.
  122.      HAM        : This switch is used to select HAM mode when no CAMG chunk
  123.                   is found.  If you don't specify this switch PPShow will
  124.                   assume a 6 plane screen is extra-halfbrite. Note that this
  125.                   switch does not force HAM mode, it merely instruct PPShow
  126.                   to use HAM mode in case of doubt.
  127.      TIME s     : Display pictures for 's' seconds.
  128.      NOCYCLE    : Do not start cycling automatically.
  129.      NOOVERSCAN : Disable overscan.
  130.      LOOP       : Display all pictures in a loop, press CTRL-D to abort.
  131.      PAL        : Use 'pal.monitor'.
  132.      NTSC       : Use 'ntsc.monitor'.
  133.      VGA        : Use 'multiscan.monitor'. Please note that when using VGA,
  134.                   LO puts the screen in EXTRALORES, HI in LORES and SHI in
  135.                   PRODUCTIVITY (same as PROD).
  136.      A2024      : Use 'a2024.monitor'.
  137.      15Hz       : Put A2024 monitor into 15Hz, rather than 10Hz.
  138.      NOFLICKER  : Kickstart 3.0 only.  If possible use a non-interlaced
  139.                   monitor mode ('DoublePAL.monitor' or 'DoubleNTSC.monitor').
  140.      MAXOSCAN   : Use VIDEO_OSCAN instead of MAX_OSCAN.  Video overscan
  141.                   offers the maximum possible overscan, but is not as system
  142.                   friendly.
  143.      JIFFIES n  : Set a delay between frames in jiffies.  A jiffie is 1/50s
  144.                   (PAL) or 1/60s (NTSC).  During animation playback you may
  145.                   press F1 to F10 to control animation playback speed.  Press
  146.                   Return to use the default speed.
  147.      TIMES n    : Set number of times to play the animation.
  148.      REPEAT     : Select repeat mode instead of loop mode (see below).
  149.      NOANIM     : Don't play animations, just display the first frame.
  150.  
  151.    The difference between loop mode and repeat mode is the following: in
  152. loop mode PPShow expects the last two frames of the animation to be the same
  153. as the first two frames, this makes looping easy and above all fast (DPaint
  154. saves animations like this).  Some animations are not like this however and
  155. if you want these to loop correctly you must select repeat mode (REPEAT),
  156. PPShow will then simply restart the animation when it finishes (note that
  157. there may be a small hickup when the animation repeats because the first frame
  158. takes longer to draw than the rest).
  159.  
  160.    PPShow can be made resident so it doesn't have to be loaded every time
  161. you use it, use the c: Resident command for this.  You can't make PPShow
  162. resident when it is crunched!!  The file is supplied as an uncrunched command
  163. file with the pure bit set.  PPShow is reentrant as well, so you can run it
  164. from several CLI's at the same time.  (Not that this is very useful, but it's
  165. possible :-)
  166.  
  167.    Examples:
  168.  
  169.     o PPShow dh0:pics/HAMpicWithoutCAMG.pic HAM
  170.  
  171.     o PPShow dir/#?.pic TIME 5 LOOP
  172.  
  173.        Show all files in directory 'dir' with a '.pic' suffix for 5 seconds
  174.        and loop until user presses CTRL-D.
  175.  
  176.     o PPShow PICS:~(#?.info) NOOVERSCAN
  177.  
  178.        Show all files on 'PICS:' NOT ending in '.info'. Disable overscan.
  179.  
  180.  
  181. - Via the WorkBench:
  182.  
  183.    There are three different ways of using PPShow via the workbench: you
  184. can set the default tool of the (crunched) ILBM/ANIM file to 'PPShow', you
  185. can single click the PPShow icon and then extend-select one or more icons
  186. (use shift click, double-clicking the last one) or you can double-click the
  187. PPShow icon and specify a filename using the file requester.
  188.    You set the default tool by single clicking the icon of the picture and
  189. selecting 'Information' from the 'Icons' menu.  You will get a window with
  190. several gadgets in it, click in the string gadget where it says 'Default tool'
  191. and enter ':ppshow'.  PPShow should be in the root directory of your disk for
  192. this to work, if e.g.  it's in the system directory you should enter
  193. ':system/ppshow'.  Last of all select the 'Save' gadget.
  194.  
  195.    Following tooltypes are recognized by PPShow (in the pictures' icon, not
  196. PPShow's icon):
  197.  
  198.      HAM        : See CLI option.
  199.      TIME=s     : Display picture for 's' seconds.
  200.      NOCYCLE    : Do not start cycling automatically.
  201.      NOOVERSCAN : Disable overscan.
  202.      LORES      : Force screen to open in LORES        mode.
  203.      HIRES      :   ''    ''    ''   ''   HIRES         ''
  204.      SUPERHIRES :   ''    ''    ''   ''   SUPERHIRES    ''
  205.      PROD       :   ''    ''    ''   ''   PRODUCTIVITY  ''
  206.      LACE       : Force interlace on.
  207.      NOLACE     : Force interlace off.
  208.      PAL        : Use 'pal.monitor'.
  209.      NTSC       : Use 'ntsc.monitor'.
  210.      VGA        : Use 'multiscan.monitor'. Please note that when using VGA,
  211.                   LO puts the screen in EXTRALORES, HI in LORES and SHI in
  212.                   PRODUCTIVITY (same as PROD).
  213.      NOFLICKER  : Kickstart 3.0 only.  If possible use a non-interlaced
  214.                   monitor mode.
  215.      MAXOSCAN   : Use VIDEO_OSCAN instead of MAX_OSCAN.  Video overscan
  216.                   offers the maximum possible overscan, but is not as system
  217.                   friendly.
  218.      JIFFIES n  : Set a delay between frames in jiffies.  A jiffie is 1/50s
  219.                   (PAL) or 1/60s (NTSC).  During animation playback you may
  220.                   press F1 to F10 to control animation playback speed.  Press
  221.                   Return to use the default speed.
  222.      TIMES n    : Set number of times to play the animation.
  223.      REPEAT     : Select repeat mode instead of loop mode (see below).
  224.  
  225. NOTE: - Follow these steps to make a simple slideshow that runs by double-
  226.         clicking an icon:  Make a script file containing something like the
  227.         following line: 'PPShow #?.pic TIME 10 LOOP'.  Set this script's
  228.         default tool to 'c:IconX' and enter 'WINDOW=CON://///AUTO' in its
  229.         tooltypes.  Put the script in a directory containing pictures (all
  230.         ending in '.pic'!).  If you now double-click this scripts icon the
  231.         slideshow will start, press ESC or CTRL-D to end.
  232.       - PPShow will add '.pp' to the filename when the file wasn't found.
  233.         This is very useful in the Workbench enviroment: you can make an
  234.         icon for 'house.pic' but name the file 'house.pic.pp'.  Now the
  235.         WorkBench will show an icon with 'house.pic' as name, but if you
  236.         doubleclick it 'house.pic.pp' will be displayed. (As long as there
  237.         is no 'house.pic' file in the directory!)
  238.       - Drag as many monitor icons to the WbStartup or Monitors drawer as
  239.         your monitor allows.  For example: if you have a multiscan monitor
  240.         drag pal, ntsc and multiscan.monitor to your Monitors drawer.  If
  241.         you do this you will have maximum ease of use of PPShow.
  242.  
  243.  
  244. 3. Features
  245. ===========
  246.  
  247.    - PPShow fully supports the 16.8 million colors and HAM8 mode of the AGA
  248.      (AA) chip set of the Amiga 4000 and Amiga 1200.
  249.  
  250.    - Abort PPShow by pressing 'Q', CTRL-C or the right mouse button.  Press
  251.      CTRL-D to abort everything and to break a script.
  252.  
  253.    - PPShow offers full overscan and monitor support: PAL, NTSC, VGA, A2024.
  254.  
  255.    - You can scroll very big pictures by pressing and holding the left mouse
  256.      button and dragging.  While you are dragging the picture the pointer
  257.      will become visible.
  258.      Note that the screen itself can be dragged by pressing Left-Amiga,
  259.      holding down the left mouse button and moving the mouse (you may have
  260.      to press something else than Left-Amiga, depending on your 'IControl'
  261.      preferences setting).
  262.  
  263.    - PPShow can be used as a simple slideshow tool.  It supports wildcards
  264.      to simplify this.
  265.  
  266.    - Deluxe Paint color cycling is supported, press <TAB> to (de)activate.
  267.      Up to 8 cycles are supported (DPaint III currently only supports 6).
  268.  
  269.    - The pesky little mouse will be removed while displaying.  Press 'M' to
  270.      toggle the mouse pointer on/off.
  271.  
  272.    - Press 'L' to load another picture, you will be presented with the
  273.      file requester.
  274.  
  275.    - Supports a change of the color palette during the animation.  Special
  276.      care has been taken to eliminate color-flashing as seen in many other
  277.      animation players (including the now obsolete PPAnim :-).
  278.  
  279.    - Press 'S' or the left mouse button to start/stop the animation.  Press
  280.      'N' to advance a frame (when stopped).
  281.  
  282.    - Reads the 'DPAN' IFF chunk DPaintIII saves with animations to find the
  283.      rate at which to play the animation.  Note that user options override
  284.      this rate (JIFFIES=n).
  285.  
  286.  
  287. 4. Note on crunching
  288. ====================
  289.  
  290.    A lot of IFF ILBM files are already crunched with the standard ByteRun1
  291. compression.  PowerPacker will crunch these files even further (most of the
  292. time) but will not crunch them as well as uncrunched ILBM files.  So save IFF
  293. files uncrunched (if you can, e.g. with PixMate) before crunching them, this
  294. way you will get the best crunching results.
  295.  
  296.  
  297.                         As always, I hope you find this program useful!
  298.  
  299.  
  300.                               PROGRAM HISTORY:
  301.  
  302. *****************************************************************************
  303. VERSION 1.0
  304.  
  305.      First release.
  306.  
  307. *****************************************************************************
  308. VERSION 1.1
  309.  
  310.      Decrunching is about 40% faster (accidently used slow decruncher in 1.0)
  311.      Screen now pops to front when picture is ready to be viewed, not before.
  312.      File requester used when arp.library is available.
  313.      'L' command added to load other pictures without restarting PPShow.
  314.  
  315. *****************************************************************************
  316. VERSION 1.1a
  317.  
  318.      The Guru isn't with me lately, after using a slow decruncher in 1.0
  319.        by accident I now used a fast but faulty decruncher in 1.1. It
  320.        sometimes didn't decrunch correctly, this has now been fixed. The
  321.        decruncher is still 40% faster than the 1.0 one. (and it's 2 bytes
  322.        shorter :^D )
  323.  
  324. *****************************************************************************
  325. VERSION 1.2
  326.  
  327.      Rewrote cycling routine in assembly, so less overhead when cycling.
  328.      Uses the all new powerpacker.library => shorter code.
  329.      Starting PPShow from the CLI with a directory as an argument now puts
  330.        up the requester positioned in that directory. Extremely useful once
  331.        you get used to this :^)
  332.      If you are running Workbench 2.0 PPShow will use the asl.library
  333.        instead of the arp.library (for the file requester).
  334.      Fixed serious bug: memory wasn't freed when an IFF error occured.
  335.      No longer tries to display small brushes (intuition doesn't like very
  336.        small screens :( )
  337.  
  338. *****************************************************************************
  339. VERSION 2.0
  340.  
  341.      PPShow requires Kickstart 2.0 to run.  Sorry to all the 1.2 and 1.3
  342.        users, just consider this program as another reason to upgrade :-)
  343.  
  344.      File requester from arp.library is no longer supported.
  345.      PPShow now uses reqtools.library (also by moi) for its requesters.
  346.        Among other things this means a much better file requester than
  347.        before (with a buffer).  Asl is no longer used, sorry Commodore :-)
  348.      Printing of screen removed, has anybody ever used this ? :-)
  349.      Improved command line format, follows AmigaDOS standard. (old option
  350.        '-h' is no longer supported!).
  351.      IFF decrunching rewritten in assembly: much faster and shorter.
  352.      Shows pictures saved in DPaint with stencil on. In other words: supports
  353.        IFF picture masking.
  354.      No longer quits when you press any key, you have to press 'Q', CTRL-C,
  355.        or right mouse button; CTRL-D aborts PPShow and breaks scripts.
  356.      Color cycling is now automatically switched on (except for brushes).
  357.      Mouse pointer visibility can be toggled.
  358.      Possibility to automatically stop displaying after a specified number
  359.        of seconds.
  360.      Many new command line options: change display resolution, switch off
  361.        overscan, disable auto-cycling, etc.
  362.      Several options may be set using Workbench tooltypes.
  363.      From Workbench, if you single-click PPShow and shift double-click a
  364.        drawer icon, PPShow will open up the file requester in that drawer.
  365.      If you use 'PPShow <file>' or extend-select <file> from Workbench and
  366.        you invoke the file requester, it will be positioned in the directory
  367.        <file> is in.
  368.      The file requester will appear on the picture screen if possible.
  369.      Canceling the file requester no longer quits PPShow.
  370.      The file requester will filter out the .info files.
  371.      Can be used as a simple slideshow program: supports wildcards and
  372.        multiple files on command line, also possible to loop the slideshow.
  373.        Picture switching is double buffered.  Multiple extended selection
  374.        from Workbench is also supported.
  375.      Overscan now done using Kickstart 2.0 display clips.
  376.      Supports all new ECS display modes (ECS Denise only) and all monitors.
  377.      Will switch to PAL or NTSC monitor automatically (ECS Agnus only).
  378.      PPShow will now show very large screens without problem, AUTOSCROLL is
  379.        switched on so the screen automatically scrolls when you move the
  380.        mouse pointer off the edge.
  381.      Screen no longer has an invisible dragbar.  Use meta-dragging (left
  382.        Amiga key + mouse) to drag the screen.
  383.      Directories are expanded to their full pathnames on startup.
  384.      PPShow now returns a returncode of 20 in case of an error or if ended
  385.        by CTRL-D.
  386.      Error reporting improved: when started from CLI, errors are printed
  387.        on the console; when started from Workbench, a requester is used.
  388.      All these great new features and PPShow grew only about 1K in size :-)
  389.  
  390.      Release 12-Jan-92
  391.      ~~~~~~~~~~~~~~~~~
  392.      Now distributed with release 1.0c of reqtools.library.
  393.      Install script fixed.
  394.  
  395. *****************************************************************************
  396. VERSION 2.1
  397.  
  398.      Uses Workbench 2.0's iffparse.library for best IFF support.
  399.      Displays SHAM (Sliced HAM), DHAM (Dynamic HAM) and DRES (Dynamic Hires,
  400.        DigiView 4.0 and MacroPaint) files.
  401.      Executes TurboGIF (by Steve Borden) or any other GIF viewer (set by var
  402.        ENV:GIFVIEWER) if it encounters a GIF file.
  403.      Will hunt for ILBM pictures in all IFF files.  E.g. shows first picture
  404.        of animation files.
  405.      Is able to show the contents of the clipboard (if filename is "-c").
  406.      Allows you to scroll big pictures by holding down the left mouse button
  407.        and dragging.  This also works for SHAM, DHAM and DRES pictures.
  408.        PPShow will update the copper list these pictures require while
  409.        scrolling.
  410.      PPShow will no longer abort upon encountering a file that is not IFF, or
  411.        not IFF ILBM.  It will try to show the next file in the wildcard/list.
  412.      When using a wildcard directories will be ignored, instead of bringing
  413.        up the file requester.
  414.  
  415. *****************************************************************************
  416. VERSION 2.2
  417.  
  418.      Version number skipped because of a fake 2.2 version of PPShow.
  419.  
  420. *****************************************************************************
  421. VERSION 2.3
  422.  
  423.      Support added for Kickstart 3.0 and the new graphics modes of the AGA
  424.        chip set.  PPShow fully supports palettes of up to 16.8 milion colors
  425.        and the HAM8 mode.  Color cycling in 16.8 million colors is not yet
  426.        supported.
  427.      On Kickstart 3.0 and pictures with enough colors PPShow will pick four
  428.        colors for the GUI (file requester).  If not enough colors are
  429.        available or on Kickstart 2.0 the palette will be temporarily reset
  430.        when needed.
  431.      Maximum overscan used is now OSCAN_MAX instead of OSCAN_VIDEO.  This is
  432.        much more system friendly.
  433.      New switch added for Kickstart 3.0 users: NOFLICKER.  Will try to use a
  434.        non-interlaced display mode to show the picture (DBLPAL or DBLNTSC).
  435.      Release 2.0c of reqtools.library included.
  436.  
  437. *****************************************************************************
  438. VERSION 3.0
  439.  
  440.      MAJOR NEW FEATURE: PPShow now plays ANIM Op5 animations.
  441.        o Supports all Amiga screen modes (including the new AGA ones).
  442.        o Supports a change of the palette during the animation.
  443.        o Animates in an Intuition screen (draggable).
  444.        o 'S' or the left mouse button starts/stops the animation, 'N'
  445.          advances a frame (when stopped).
  446.        o Supports the 'DPAN' IFF chunk DPaintIV saves with animations to
  447.          find the animation playback rate.
  448.        o Allows for an optional playback delay in jiffies (JIFFIES switch).
  449.          During animation playback pressing F1 to F10 changes the playback
  450.          speed. Pressing Return will use the default playback speed.
  451.        o Supports looping and repeating anims (REPEAT switch).
  452.        o TIMES switch to set number of times animation should be played back.
  453.        o Animation is played back on a standard Intuition screen.
  454.      New MAXOSCAN switch to select VIDEO_OSCAN overscan.  Useful to get the
  455.        maximum overscan out of DoublePAL and DoubleNTSC.
  456.      Now also recognizes LORES, HIRES, SUPERHIRES, PROD, LACE, NOLACE, PAL,
  457.        NTSC and VGA tooltypes, was well as the new MAXOSCAN, REPEAT, TIMES
  458.        and JIFFIES tooltypes.
  459.      Fixed bug: pressing Right Mouse Button when PPShow was used with LOOP
  460.        and TIME keywords no longer allowed you to end PPShow by pressing
  461.        Esc.  Fixed.
  462.      Release 2.1a of reqtools.library included.
  463.  
  464. *****************************************************************************
  465. VERSION 3.0a
  466.  
  467.      Several causes of memory loss found and fixed.  All of these popped up
  468.        when using PPShow to display/play several pictures/animations in a row
  469.        with or without the LOOP switch.
  470.      Decrunch color changed to DECR_NONE.  No more flashing pictures when you
  471.        use PPShow as a slideshow program :-)
  472.      Standard wait pointer (system wait pointer on 3.0) is set when loading
  473.        the next picture/animation.
  474.      Bug fix: it was not possible to stop PPShow when you used LOOP switch
  475.        on non-iff files.
  476.  
  477. *****************************************************************************
  478.  
  479. PPShow 3.0a written by Nico François (Yes, Nico is my first name :-)
  480.             thanks to Ives Aerst for all the suggestions and beta-testing.
  481.  
  482.  
  483. "Sometimes people can be oh so dense" - Pixies
  484.  
  485.  
  486. (c) 1991/1992 Nico François
  487.  
  488.                                    //
  489.                        Thanks to \X/ Amiga for being the best computer ever!
  490.  
  491.